Skip to content

feat: support direct check for boolean is true#797

Merged
vbreuss merged 5 commits intomainfrom
topic/support-bool-check-without-istrue
Sep 26, 2025
Merged

feat: support direct check for boolean is true#797
vbreuss merged 5 commits intomainfrom
topic/support-bool-check-without-istrue

Conversation

@vbreuss
Copy link
Copy Markdown
Member

@vbreuss vbreuss commented Sep 26, 2025

This PR adds support for direct boolean assertions in the aweXpect library, allowing users to write await That(boolValue) to check if a boolean is true, instead of requiring the more verbose await That(boolValue).IsTrue().

Key changes:

  • Introduces a new ThatBool class that automatically validates boolean values as true when no explicit constraint is provided
  • Adds a new That(bool) overload to the main API
  • Updates test files to use the new functionality where appropriate

@vbreuss vbreuss self-assigned this Sep 26, 2025
Copilot AI review requested due to automatic review settings September 26, 2025 19:59
@vbreuss vbreuss added the enhancement New feature or request label Sep 26, 2025
Copy link
Copy Markdown

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds support for direct boolean assertions in the aweXpect library, allowing users to write await That(boolValue) to check if a boolean is true, instead of requiring the more verbose await That(boolValue).IsTrue().

Key changes:

  • Introduces a new ThatBool class that automatically validates boolean values as true when no explicit constraint is provided
  • Adds a new That(bool) overload to the main API
  • Updates test files to use the new functionality where appropriate

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 2 comments.

Show a summary per file
File Description
Source/aweXpect.Core/Expect.cs Adds new That(bool) overload that returns ThatBool instance
Source/aweXpect.Core/Core/ThatBool.cs New class implementing boolean-specific expectation behavior with automatic IsTrue constraint
Tests/aweXpect.Tests/Booleans/ThatBool.cs Adds comprehensive test coverage for the new boolean assertion functionality
Tests/aweXpect.Core.Tests/Results/ExpectationTests.cs Updates existing test to use integer comparison instead of boolean to avoid new behavior
Tests/aweXpect.Core.Api.Tests/Expected/*.txt Updates API surface documentation to reflect new public ThatBool class and That(bool) method

Comment thread Source/aweXpect.Core/Core/ThatBool.cs Outdated
Comment thread Source/aweXpect.Core/Core/ThatBool.cs
@vbreuss vbreuss enabled auto-merge (squash) September 26, 2025 20:02
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 26, 2025

Test Results

    14 files   - 24      14 suites   - 24   5m 22s ⏱️ + 1m 31s
17 959 tests  - 23  17 957 ✅  - 23  2 💤 ±0  0 ❌ ±0 
50 514 runs   - 72  50 512 ✅  - 72  2 💤 ±0  0 ❌ ±0 

Results for commit 9ea8227. ± Comparison against base commit 9fca980.

♻️ This comment has been updated with latest results.

@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Sep 26, 2025

🚀 Benchmark Results

Details

BenchmarkDotNet v0.14.0, Ubuntu 24.04.3 LTS (Noble Numbat)
AMD EPYC 7763, 1 CPU, 4 logical and 2 physical cores
.NET SDK 8.0.414
[Host] : .NET 8.0.20 (8.0.2025.41914), X64 RyuJIT AVX2

Job=InProcess Toolchain=InProcessEmitToolchain IterationCount=15
LaunchCount=1 WarmupCount=10

Method Mean Error StdDev Gen0 Gen1 Allocated
Bool_aweXpect 255.5 ns 2.04 ns 1.90 ns 0.0300 - 504 B
Bool_FluentAssertions 274.5 ns 4.55 ns 3.55 ns 0.0567 - 952 B
Bool_TUnit 980.4 ns 8.45 ns 7.05 ns 0.1431 - 2408 B
Equivalency_aweXpect 323,012.8 ns 652.42 ns 578.35 ns 20.0195 0.9766 335556 B
Equivalency_FluentAssertions 2,496,782.3 ns 10,523.87 ns 9,329.14 ns 273.4375 46.8750 4584416 B
Equivalency_TUnit 708,869.8 ns 3,187.44 ns 2,981.54 ns 51.7578 2.9297 880545 B
Int_GreaterThan_aweXpect 278.4 ns 4.28 ns 3.79 ns 0.0486 - 816 B
Int_GreaterThan_FluentAssertions 354.7 ns 5.29 ns 4.95 ns 0.0730 - 1224 B
Int_GreaterThan_TUnit 1,310.4 ns 8.55 ns 7.99 ns 0.1774 - 2984 B
ItemsCount_AtLeast_aweXpect 556.0 ns 4.85 ns 4.54 ns 0.0868 - 1464 B
ItemsCount_AtLeast_FluentAssertions 579.8 ns 10.52 ns 9.84 ns 0.1192 - 2008 B
ItemsCount_AtLeast_TUnit 19,462.2 ns 140.13 ns 131.08 ns 1.6174 - 27480 B
String_aweXpect 528.3 ns 6.44 ns 5.71 ns 0.0734 - 1232 B
String_FluentAssertions 691.2 ns 9.27 ns 8.67 ns 0.1287 - 2168 B
String_TUnit 1,369.3 ns 13.98 ns 13.08 ns 0.1831 - 3072 B
StringArray_aweXpect 1,990.7 ns 10.23 ns 9.07 ns 0.1717 - 2888 B
StringArray_FluentAssertions 1,378.8 ns 20.30 ns 18.99 ns 0.2480 - 4152 B
StringArray_TUnit 3,464.9 ns 25.68 ns 24.02 ns 0.3128 - 5296 B
StringArrayInAnyOrder_aweXpect 2,637.1 ns 11.79 ns 9.85 ns 0.1831 - 3080 B
StringArrayInAnyOrder_FluentAssertions 156,736.3 ns 672.97 ns 596.57 ns 3.4180 - 63788 B
StringArrayInAnyOrder_TUnit 4,009.8 ns 44.97 ns 39.87 ns 0.3815 - 6488 B

@github-actions
Copy link
Copy Markdown
Contributor

👽 Mutation Results

Mutation testing badge

aweXpect

Details
File Score Killed Survived Timeout No Coverage Ignored Compile Errors Total Detected Total Undetected Total Mutants

The final mutation score is NaN%

Coverage Thresholds: high:80 low:60 break:0

aweXpect.Core

Details
File Score Killed Survived Timeout No Coverage Ignored Compile Errors Total Detected Total Undetected Total Mutants
Core/ThatBool.cs 8.70% 2 0 0 21 7 8 2 21 38
Expect.cs 100.00% 21 0 0 0 0 0 21 0 21

The final mutation score is 52.27%

Coverage Thresholds: high:80 low:60 break:0

@sonarqubecloud
Copy link
Copy Markdown

@vbreuss vbreuss merged commit 42ec1de into main Sep 26, 2025
14 checks passed
@vbreuss vbreuss deleted the topic/support-bool-check-without-istrue branch September 26, 2025 20:29
github-actions Bot added a commit that referenced this pull request Sep 26, 2025
github-actions Bot added a commit that referenced this pull request Sep 26, 2025
@github-actions
Copy link
Copy Markdown
Contributor

This is addressed in release v2.26.0.

vbreuss pushed a commit to Testably/aweXpect.Reflection that referenced this pull request May 6, 2026
Updated [aweXpect](https://github.com/aweXpect/aweXpect) from 2.26.0 to 2.31.0.

<details>
<summary>Release notes</summary>

_Sourced from [aweXpect's releases](https://github.com/aweXpect/aweXpect/releases)._

## 2.31.0

## What's Changed
* chore: Bump the xunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#883
* chore: Bump apexskier/github-release-commenter from 1.3.6 to 1.4.1 by @​dependabot[bot] in Testably/aweXpect#884
* chore: Bump SharpCompress from 0.42.1 to 0.44.3 by @​dependabot[bot] in Testably/aweXpect#886
* docs: support nested directories in extensions by @​vbreuss in Testably/aweXpect#887
* chore: Bump the tunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#888
* chore: Bump SharpCompress from 0.44.3 to 0.44.5 by @​dependabot[bot] in Testably/aweXpect#889
* chore: Bump actions/upload-artifact from 6 to 7 by @​dependabot[bot] in Testably/aweXpect#898
* chore: Bump actions/download-artifact from 7 to 8 by @​dependabot[bot] in Testably/aweXpect#899
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#890
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#895
* chore: Bump coverlet.collector from 6.0.4 to 8.0.0 by @​dependabot[bot] in Testably/aweXpect#897
* chore: update docusaurus webpage by @​vbreuss in Testably/aweXpect#900
* refactor: fix build warnings by @​vbreuss in Testably/aweXpect#902
* feat: give access to `Timeout` and `CancellationToken` in the `ExpectationBuilder` by @​vbreuss in Testably/aweXpect#901
* chore: Bump Microsoft.Testing.Extensions.CodeCoverage from 18.3.2 to 18.5.2 by @​dependabot[bot] in Testably/aweXpect#906
* chore: Bump Microsoft.NET.Test.Sdk from 18.0.1 to 18.3.0 by @​dependabot[bot] in Testably/aweXpect#905
* chore: Bump the nunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#903
* chore: bump aweXpect.Core to v2.28.0 by @​vbreuss in Testably/aweXpect#909
* refactor: migrate to slnx format by @​vbreuss in Testably/aweXpect#908


**Full Changelog**: Testably/aweXpect@v2.30.0...v2.31.0

## 2.30.0

## What's Changed
* chore: Bump actions/checkout from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#850
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#851
* chore: Bump the tunit group with 3 updates by @​dependabot[bot] in Testably/aweXpect#853
* chore: Bump Microsoft.NET.Test.Sdk from 18.0.0 to 18.0.1 by @​dependabot[bot] in Testably/aweXpect#854
* chore: Bump Microsoft.Testing.Extensions.TrxReport from 2.0.1 to 2.0.2 by @​dependabot[bot] in Testably/aweXpect#855
* chore: update docusaurus dependencies by @​vbreuss in Testably/aweXpect#856
* chore: bump nuke to v10.1.0 by @​vbreuss in Testably/aweXpect#862
* chore: Bump BenchmarkDotNet from 0.15.6 to 0.15.8 by @​dependabot[bot] in Testably/aweXpect#860
* chore: Bump PublicApiGenerator from 11.5.0 to 11.5.3 by @​dependabot[bot] in Testably/aweXpect#861
* chore: Bump PublicApiGenerator from 11.5.3 to 11.5.4 by @​dependabot[bot] in Testably/aweXpect#864
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#863
* chore: Bump the xunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#858
* chore: Bump actions/download-artifact from 6 to 7 by @​dependabot[bot] in Testably/aweXpect#866
* chore: Bump actions/upload-artifact from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#867
* chore: Bump the tunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#868
* chore: Bump SharpCompress from 0.41.0 to 0.42.1 by @​dependabot[bot] in Testably/aweXpect#869
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#876
* chore: Bump Microsoft.Testing.Extensions.CodeCoverage and 2 others by @​dependabot[bot] in Testably/aweXpect#875
* feat: add implicit conversion to `Times` by @​vbreuss in Testably/aweXpect#878
* chore: Bump TUnit and TUnit.Assertions by @​dependabot[bot] in Testably/aweXpect#879
* feat: support async `Because` reason by @​vbreuss in Testably/aweXpect#880
* chore: bump aweXpect.Core to v2.27.0 by @​vbreuss in Testably/aweXpect#881


**Full Changelog**: Testably/aweXpect@v2.29.0...v2.30.0

## 2.29.0

## What's Changed
* chore: update aweXpect to v2.28.0 by @​vbreuss in Testably/aweXpect#841
* refactor: move needs from pack to push by @​vbreuss in Testably/aweXpect#840
* chore: Bump the tunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#842
* chore: Bump BenchmarkDotNet from 0.15.5 to 0.15.6 by @​dependabot[bot] in Testably/aweXpect#843
* chore: Bump PublicApiGenerator from 11.4.6 to 11.5.0 by @​dependabot[bot] in Testably/aweXpect#844
* chore: Bump SharpCompress from 0.39.0 to 0.41.0 by @​dependabot[bot] in Testably/aweXpect#845
* feat: add support for .NET 10 by @​vbreuss in Testably/aweXpect#794
* fix: disable failing mutation tests by @​vbreuss in Testably/aweXpect#847
* fix: add attributes only when they are available by @​vbreuss in Testably/aweXpect#846
* chore: bump aweXpect.Core to v2.26.0 by @​vbreuss in Testably/aweXpect#848
* fix: build error with MTP mode of dotnet test by @​vbreuss in Testably/aweXpect#849


**Full Changelog**: Testably/aweXpect@v2.28.0...v2.29.0

## 2.28.0

## What's Changed
* chore: update aweXpect to v2.27.1 by @​vbreuss in Testably/aweXpect#818
* docs: document Mockolate by @​vbreuss in Testably/aweXpect#828
* chore: Bump actions/setup-node from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#819
* chore: Bump actions/download-artifact from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#822
* chore: Bump actions/upload-artifact from 4 to 5 by @​dependabot[bot] in Testably/aweXpect#823
* chore: Bump BenchmarkDotNet from 0.14.0 to 0.15.4 by @​dependabot[bot] in Testably/aweXpect#824
* chore: Bump FluentAssertions from 8.2.0 to 8.8.0 by @​dependabot[bot] in Testably/aweXpect#825
* docs: fix docusaurus warning by @​vbreuss in Testably/aweXpect#829
* chore: Bump Microsoft.NET.Test.Sdk from 17.14.1 to 18.0.0 by @​dependabot[bot] in Testably/aweXpect#826
* chore: Bump Microsoft.Testing.Extensions.CodeCoverage from 17.14.2 to 18.1.0 by @​dependabot[bot] in Testably/aweXpect#827
* chore: update TUnit to v0.88.0 by @​vbreuss in Testably/aweXpect#830
* feat: improve test output for dictionary `ContainsKey` by @​vbreuss in Testably/aweXpect#835
* chore: Bump the xunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#833
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#831
* chore: Bump BenchmarkDotNet from 0.15.4 to 0.15.5 by @​dependabot[bot] in Testably/aweXpect#834
* fix: infinite loop in result contexts by @​vbreuss in Testably/aweXpect#836
* fix: use list in `ResultContexts` by @​vbreuss in Testably/aweXpect#837
* feat: include actual and expected context in string contains by @​vbreuss in Testably/aweXpect#838
* chore: update aweXpect.Core to v2.25.2 by @​vbreuss in Testably/aweXpect#839


**Full Changelog**: Testably/aweXpect@v2.27.1...v2.28.0

## 2.27.1

## What's Changed
* fix: formatting of nested types within generic types by @​vbreuss in Testably/aweXpect#815
* refactor: reduce allocations for context by @​vbreuss in Testably/aweXpect#816
* chore: bump aweXpect.Core to v2.25.1 by @​vbreuss in Testably/aweXpect#817


**Full Changelog**: Testably/aweXpect@v2.27.0...v2.27.1

## 2.27.0

## What's Changed
* chore: Bump the xunit group with 3 updates by @​dependabot[bot] in Testably/aweXpect#800
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#801
* feat: allow customization of the `MaximumStringLength` by @​vbreuss in Testably/aweXpect#802
* chore: update docusaurus to v3.9.1 by @​vbreuss in Testably/aweXpect#803
* fix: formatting of nullable types by @​vbreuss in Testably/aweXpect#808
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#805
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#806
* chore: update TUnit to v0.70.0 by @​vbreuss in Testably/aweXpect#809
* feat: move framework adapters to source generation by @​vbreuss in Testably/aweXpect#810
* coverage: ensure that `NaN` is considered equal to `NaN` by @​vbreuss in Testably/aweXpect#811
* chore: bump the aweXpect group by @​vbreuss in Testably/aweXpect#812
* chore: update aweXpect.Core to v2.25.0 by @​vbreuss in Testably/aweXpect#813
* feat: support MSTest v4 by @​vbreuss in Testably/aweXpect#814


**Full Changelog**: Testably/aweXpect@v2.26.0...v2.27.0

Commits viewable in [compare view](Testably/aweXpect@v2.26.0...v2.31.0).
</details>

Updated [aweXpect.Core](https://github.com/aweXpect/aweXpect) from 2.24.0 to 2.28.0.

<details>
<summary>Release notes</summary>

_Sourced from [aweXpect.Core's releases](https://github.com/aweXpect/aweXpect/releases)._

## 2.28.0

## What's Changed
* chore: update aweXpect to v2.27.1 by @​vbreuss in Testably/aweXpect#818
* docs: document Mockolate by @​vbreuss in Testably/aweXpect#828
* chore: Bump actions/setup-node from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#819
* chore: Bump actions/download-artifact from 5 to 6 by @​dependabot[bot] in Testably/aweXpect#822
* chore: Bump actions/upload-artifact from 4 to 5 by @​dependabot[bot] in Testably/aweXpect#823
* chore: Bump BenchmarkDotNet from 0.14.0 to 0.15.4 by @​dependabot[bot] in Testably/aweXpect#824
* chore: Bump FluentAssertions from 8.2.0 to 8.8.0 by @​dependabot[bot] in Testably/aweXpect#825
* docs: fix docusaurus warning by @​vbreuss in Testably/aweXpect#829
* chore: Bump Microsoft.NET.Test.Sdk from 17.14.1 to 18.0.0 by @​dependabot[bot] in Testably/aweXpect#826
* chore: Bump Microsoft.Testing.Extensions.CodeCoverage from 17.14.2 to 18.1.0 by @​dependabot[bot] in Testably/aweXpect#827
* chore: update TUnit to v0.88.0 by @​vbreuss in Testably/aweXpect#830
* feat: improve test output for dictionary `ContainsKey` by @​vbreuss in Testably/aweXpect#835
* chore: Bump the xunit group with 2 updates by @​dependabot[bot] in Testably/aweXpect#833
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#831
* chore: Bump BenchmarkDotNet from 0.15.4 to 0.15.5 by @​dependabot[bot] in Testably/aweXpect#834
* fix: infinite loop in result contexts by @​vbreuss in Testably/aweXpect#836
* fix: use list in `ResultContexts` by @​vbreuss in Testably/aweXpect#837
* feat: include actual and expected context in string contains by @​vbreuss in Testably/aweXpect#838
* chore: update aweXpect.Core to v2.25.2 by @​vbreuss in Testably/aweXpect#839


**Full Changelog**: Testably/aweXpect@v2.27.1...v2.28.0

## 2.27.1

## What's Changed
* fix: formatting of nested types within generic types by @​vbreuss in Testably/aweXpect#815
* refactor: reduce allocations for context by @​vbreuss in Testably/aweXpect#816
* chore: bump aweXpect.Core to v2.25.1 by @​vbreuss in Testably/aweXpect#817


**Full Changelog**: Testably/aweXpect@v2.27.0...v2.27.1

## 2.27.0

## What's Changed
* chore: Bump the xunit group with 3 updates by @​dependabot[bot] in Testably/aweXpect#800
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#801
* feat: allow customization of the `MaximumStringLength` by @​vbreuss in Testably/aweXpect#802
* chore: update docusaurus to v3.9.1 by @​vbreuss in Testably/aweXpect#803
* fix: formatting of nullable types by @​vbreuss in Testably/aweXpect#808
* chore: Bump the mstest group with 2 updates by @​dependabot[bot] in Testably/aweXpect#805
* chore: Bump the nunit group with 1 update by @​dependabot[bot] in Testably/aweXpect#806
* chore: update TUnit to v0.70.0 by @​vbreuss in Testably/aweXpect#809
* feat: move framework adapters to source generation by @​vbreuss in Testably/aweXpect#810
* coverage: ensure that `NaN` is considered equal to `NaN` by @​vbreuss in Testably/aweXpect#811
* chore: bump the aweXpect group by @​vbreuss in Testably/aweXpect#812
* chore: update aweXpect.Core to v2.25.0 by @​vbreuss in Testably/aweXpect#813
* feat: support MSTest v4 by @​vbreuss in Testably/aweXpect#814


**Full Changelog**: Testably/aweXpect@v2.26.0...v2.27.0

## 2.26.0

## What's Changed
* feat: add string property result by @​vbreuss in Testably/aweXpect#795
* feat: support direct check for boolean is `true` by @​vbreuss in Testably/aweXpect#797
* chore: update aweXpect.Core to v2.24.0 by @​vbreuss in Testably/aweXpect#798


**Full Changelog**: Testably/aweXpect@v2.25.0...v2.26.0

## 2.25.0

## What's Changed
* refactor!: make `IStringMatchType` asynchronous by @​vbreuss in Testably/aweXpect#787
* refactor: make `EquivalencyExpectationBuilder` public by @​vbreuss in Testably/aweXpect#788
* chore: bump aweXpect.Core to v2.22.0 by @​vbreuss in Testably/aweXpect#789
* fix: handle `null` in `It.Is` by @​vbreuss in Testably/aweXpect#790
* fix: correct error message for prefix/suffix of empty strings by @​vbreuss in Testably/aweXpect#791
* chore: bump the aweXpect group by @​vbreuss in Testably/aweXpect#792
* feat: add `WithoutMessage` for delegate assertions by @​vbreuss in Testably/aweXpect#793


**Full Changelog**: Testably/aweXpect@v2.24.0...v2.25.0

Commits viewable in [compare view](Testably/aweXpect@v2.24.0...v2.28.0).
</details>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request state: released The issue is released

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants